The CxNoteEditor object contains the following methods:
The Configure method launches an Note Service Definitions dialog box which is used to configure Note attributes.
Configure() As Integer
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
Close or Save button was pressed. |
Example
The following example launches an Note Service Definitions dialog box.
|
Sub Dim iRet iRet = NoteEditor.Configure MsgBox iRet End Sub |
The Connect method connects to a Note service.
Connect(DomainSiteService As String)
| Parameter | Required | Description |
|---|---|---|
|
DomainSiteService |
Yes |
The [Domain]Site.Service to which to connect. A domain is optional. The service must be a valid NOTE. |
Example
The following example creates and connects the CxNoteEditor object.
|
Sub Dim NoteEditor Set NoteEditor = CreateObject("CxEditors.CxNoteEditor") NoteEditor.Connect("[5410]CYGDEMO.NOTE") End Sub |
The Delete method deletes a Note record.
Delete(QueueKey As String) As Integer
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to delete. |
The Disconnect method disconnects from the connected Note service.
Disconnect()
Example
The following example disconnects the NoteEditor object.
|
Sub NoteEditor.Disconnect End Sub |
The Edit method launches an Note Properties dialog box for the specified record.
Edit(QueueKey As String) As Integer
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to edit. |
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches an Note Properties dialog box for record "0000000001."
|
Sub Dim iRet iRet = NoteEditor.Edit("0000000001")
MsgBox iRet End Sub |
The New method launches a Create New Note dialog box.
New() As Integer
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a Create New Note dialog box.
|
Sub Dim iRet iRet = NoteEditor.New
MsgBox iRet End Sub |
The Newish method creates a new, initially-populated record.
Newish(pRecord As INote) As Integer
| Parameter | Required | Description |
|---|---|---|
|
pRecord |
Yes |
|
Example
The View method launches a Note Properties dialog box for the specified record to view or edit a Note entry.
View(Key As String, EditEnabled As Boolean) As Integer
| Parameter | Required | Description |
|---|---|---|
|
Key |
Yes |
The database queue key of the record to view/edit. |
|
EditEnabled |
Yes |
Set this parameter to true to enable editing of a record. |
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches an Note Properties dialog box for record "0000000001."
|
Sub Dim iRet iRet = NoteEditor.View("0000000001", True) MsgBox iRet End Sub |
|
|
|
